Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Add details to getting started contract deployment #5220

Merged
merged 1 commit into from
Mar 14, 2024

Conversation

critesjosh
Copy link
Contributor

Add some feedback based on office hours today.

@AztecBot
Copy link
Collaborator

Docs Preview

Hey there! 👋 You can check your preview at https://65f34e4104fec7b22c840af1--aztec-docs-dev.netlify.app

@critesjosh critesjosh merged commit 5c267ae into master Mar 14, 2024
97 checks passed
@critesjosh critesjosh deleted the jc/docs/oh-feedback branch March 14, 2024 19:25
critesjosh pushed a commit that referenced this pull request Mar 14, 2024
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-package: 0.28.0</summary>

##
[0.28.0](aztec-package-v0.27.2...aztec-package-v0.28.0)
(2024-03-14)


### ⚠ BREAKING CHANGES

* Support contracts with no constructor
([#5175](#5175))

### Features

* Support contracts with no constructor
([#5175](#5175))
([df7fa32](df7fa32))
</details>

<details><summary>barretenberg.js: 0.28.0</summary>

##
[0.28.0](barretenberg.js-v0.27.2...barretenberg.js-v0.28.0)
(2024-03-14)


### Miscellaneous

* **barretenberg.js:** Synchronize aztec-packages versions
</details>

<details><summary>aztec-cli: 0.28.0</summary>

##
[0.28.0](aztec-cli-v0.27.2...aztec-cli-v0.28.0)
(2024-03-14)


### ⚠ BREAKING CHANGES

* Support contracts with no constructor
([#5175](#5175))

### Features

* Support contracts with no constructor
([#5175](#5175))
([df7fa32](df7fa32))
</details>

<details><summary>aztec-packages: 0.28.0</summary>

##
[0.28.0](aztec-packages-v0.27.2...aztec-packages-v0.28.0)
(2024-03-14)


### ⚠ BREAKING CHANGES

* Support contracts with no constructor
([#5175](#5175))

### Features

* **avm-simulator:** Euclidean and field div
([#5181](#5181))
([037a38f](037a38f))
* Isolate Plonk dependencies
([#5068](#5068))
([5cbbd7d](5cbbd7d))
* New brillig field operations and refactor of binary operations
([#5208](#5208))
([eb69504](eb69504))
* Parallelize linearly dependent contribution in PG
([#4742](#4742))
([d1799ae](d1799ae))
* Parity circuits
([#5082](#5082))
([335c46e](335c46e))
* Support contracts with no constructor
([#5175](#5175))
([df7fa32](df7fa32))
* Track side effects in public
([#5129](#5129))
([d666f6f](d666f6f)),
closes
[#5185](#5185)
* Update SMT Circuit class and add gate relaxation functionality
([#5176](#5176))
([5948996](5948996))


### Bug Fixes

* **avm-transpiler:** FDIV and U128 test case
([#5200](#5200))
([6977e81](6977e81))
* Barretenberg-acir-tests-bb.js thru version bump
([#5216](#5216))
([9298f93](9298f93))
* Do not release docs on every commit to master
([#5214](#5214))
([c34a299](c34a299))
* Fail transaction if we revert in setup or teardown
([#5093](#5093))
([db9a960](db9a960))
* Intermittent invert 0 in Goblin
([#5189](#5189))
([6c70624](6c70624))
* Point docs links to current tag if available
([#5219](#5219))
([0e9c7c7](0e9c7c7))
* Remove embedded srs
([#5173](#5173))
([cfd673d](cfd673d))
* Split setup/teardown functions when there's no public app logic
([#5156](#5156))
([2ee13b3](2ee13b3))
* Validate EthAddress size in aztec-nr
([#5198](#5198))
([201c5e1](201c5e1))


### Miscellaneous

* Add dependency instructions to bberg README
([#5187](#5187))
([850febc](850febc))
* **avm-simulator:** Make sure we support Map storage
([#5207](#5207))
([08835f9](08835f9))
* **avm-simulator:** Restructure contract storage tests
([#5194](#5194))
([fcdd1cc](fcdd1cc))
* **docs:** Add details to getting started contract deployment
([#5220](#5220))
([5c267ae](5c267ae))
* Moving wit comms and witness and comm labels from instance to oink
([#5199](#5199))
([19eb7f9](19eb7f9))
* Oink
([#5210](#5210))
([321f149](321f149))
* Pull noir
([#5193](#5193))
([aa90f6e](aa90f6e))
* Trying to fix intermitent ci failure for boxes
([#5182](#5182))
([f988cb8](f988cb8))


### Documentation

* **yellow-paper:** Add pseudocode for verifying broadcasted functions
in contract deployment
([#4431](#4431))
([8bdb921](8bdb921))
</details>

<details><summary>barretenberg: 0.28.0</summary>

##
[0.28.0](barretenberg-v0.27.2...barretenberg-v0.28.0)
(2024-03-14)


### Features

* **avm-simulator:** Euclidean and field div
([#5181](#5181))
([037a38f](037a38f))
* Isolate Plonk dependencies
([#5068](#5068))
([5cbbd7d](5cbbd7d))
* New brillig field operations and refactor of binary operations
([#5208](#5208))
([eb69504](eb69504))
* Parallelize linearly dependent contribution in PG
([#4742](#4742))
([d1799ae](d1799ae))
* Update SMT Circuit class and add gate relaxation functionality
([#5176](#5176))
([5948996](5948996))


### Bug Fixes

* Barretenberg-acir-tests-bb.js thru version bump
([#5216](#5216))
([9298f93](9298f93))
* Intermittent invert 0 in Goblin
([#5189](#5189))
([6c70624](6c70624))
* Remove embedded srs
([#5173](#5173))
([cfd673d](cfd673d))


### Miscellaneous

* Add dependency instructions to bberg README
([#5187](#5187))
([850febc](850febc))
* Moving wit comms and witness and comm labels from instance to oink
([#5199](#5199))
([19eb7f9](19eb7f9))
* Oink
([#5210](#5210))
([321f149](321f149))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
AztecBot added a commit to AztecProtocol/barretenberg that referenced this pull request Mar 15, 2024
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-package: 0.28.0</summary>

##
[0.28.0](AztecProtocol/aztec-packages@aztec-package-v0.27.2...aztec-package-v0.28.0)
(2024-03-14)


### ⚠ BREAKING CHANGES

* Support contracts with no constructor
([#5175](AztecProtocol/aztec-packages#5175))

### Features

* Support contracts with no constructor
([#5175](AztecProtocol/aztec-packages#5175))
([df7fa32](AztecProtocol/aztec-packages@df7fa32))
</details>

<details><summary>barretenberg.js: 0.28.0</summary>

##
[0.28.0](AztecProtocol/aztec-packages@barretenberg.js-v0.27.2...barretenberg.js-v0.28.0)
(2024-03-14)


### Miscellaneous

* **barretenberg.js:** Synchronize aztec-packages versions
</details>

<details><summary>aztec-cli: 0.28.0</summary>

##
[0.28.0](AztecProtocol/aztec-packages@aztec-cli-v0.27.2...aztec-cli-v0.28.0)
(2024-03-14)


### ⚠ BREAKING CHANGES

* Support contracts with no constructor
([#5175](AztecProtocol/aztec-packages#5175))

### Features

* Support contracts with no constructor
([#5175](AztecProtocol/aztec-packages#5175))
([df7fa32](AztecProtocol/aztec-packages@df7fa32))
</details>

<details><summary>aztec-packages: 0.28.0</summary>

##
[0.28.0](AztecProtocol/aztec-packages@aztec-packages-v0.27.2...aztec-packages-v0.28.0)
(2024-03-14)


### ⚠ BREAKING CHANGES

* Support contracts with no constructor
([#5175](AztecProtocol/aztec-packages#5175))

### Features

* **avm-simulator:** Euclidean and field div
([#5181](AztecProtocol/aztec-packages#5181))
([037a38f](AztecProtocol/aztec-packages@037a38f))
* Isolate Plonk dependencies
([#5068](AztecProtocol/aztec-packages#5068))
([5cbbd7d](AztecProtocol/aztec-packages@5cbbd7d))
* New brillig field operations and refactor of binary operations
([#5208](AztecProtocol/aztec-packages#5208))
([eb69504](AztecProtocol/aztec-packages@eb69504))
* Parallelize linearly dependent contribution in PG
([#4742](AztecProtocol/aztec-packages#4742))
([d1799ae](AztecProtocol/aztec-packages@d1799ae))
* Parity circuits
([#5082](AztecProtocol/aztec-packages#5082))
([335c46e](AztecProtocol/aztec-packages@335c46e))
* Support contracts with no constructor
([#5175](AztecProtocol/aztec-packages#5175))
([df7fa32](AztecProtocol/aztec-packages@df7fa32))
* Track side effects in public
([#5129](AztecProtocol/aztec-packages#5129))
([d666f6f](AztecProtocol/aztec-packages@d666f6f)),
closes
[#5185](AztecProtocol/aztec-packages#5185)
* Update SMT Circuit class and add gate relaxation functionality
([#5176](AztecProtocol/aztec-packages#5176))
([5948996](AztecProtocol/aztec-packages@5948996))


### Bug Fixes

* **avm-transpiler:** FDIV and U128 test case
([#5200](AztecProtocol/aztec-packages#5200))
([6977e81](AztecProtocol/aztec-packages@6977e81))
* Barretenberg-acir-tests-bb.js thru version bump
([#5216](AztecProtocol/aztec-packages#5216))
([9298f93](AztecProtocol/aztec-packages@9298f93))
* Do not release docs on every commit to master
([#5214](AztecProtocol/aztec-packages#5214))
([c34a299](AztecProtocol/aztec-packages@c34a299))
* Fail transaction if we revert in setup or teardown
([#5093](AztecProtocol/aztec-packages#5093))
([db9a960](AztecProtocol/aztec-packages@db9a960))
* Intermittent invert 0 in Goblin
([#5189](AztecProtocol/aztec-packages#5189))
([6c70624](AztecProtocol/aztec-packages@6c70624))
* Point docs links to current tag if available
([#5219](AztecProtocol/aztec-packages#5219))
([0e9c7c7](AztecProtocol/aztec-packages@0e9c7c7))
* Remove embedded srs
([#5173](AztecProtocol/aztec-packages#5173))
([cfd673d](AztecProtocol/aztec-packages@cfd673d))
* Split setup/teardown functions when there's no public app logic
([#5156](AztecProtocol/aztec-packages#5156))
([2ee13b3](AztecProtocol/aztec-packages@2ee13b3))
* Validate EthAddress size in aztec-nr
([#5198](AztecProtocol/aztec-packages#5198))
([201c5e1](AztecProtocol/aztec-packages@201c5e1))


### Miscellaneous

* Add dependency instructions to bberg README
([#5187](AztecProtocol/aztec-packages#5187))
([850febc](AztecProtocol/aztec-packages@850febc))
* **avm-simulator:** Make sure we support Map storage
([#5207](AztecProtocol/aztec-packages#5207))
([08835f9](AztecProtocol/aztec-packages@08835f9))
* **avm-simulator:** Restructure contract storage tests
([#5194](AztecProtocol/aztec-packages#5194))
([fcdd1cc](AztecProtocol/aztec-packages@fcdd1cc))
* **docs:** Add details to getting started contract deployment
([#5220](AztecProtocol/aztec-packages#5220))
([5c267ae](AztecProtocol/aztec-packages@5c267ae))
* Moving wit comms and witness and comm labels from instance to oink
([#5199](AztecProtocol/aztec-packages#5199))
([19eb7f9](AztecProtocol/aztec-packages@19eb7f9))
* Oink
([#5210](AztecProtocol/aztec-packages#5210))
([321f149](AztecProtocol/aztec-packages@321f149))
* Pull noir
([#5193](AztecProtocol/aztec-packages#5193))
([aa90f6e](AztecProtocol/aztec-packages@aa90f6e))
* Trying to fix intermitent ci failure for boxes
([#5182](AztecProtocol/aztec-packages#5182))
([f988cb8](AztecProtocol/aztec-packages@f988cb8))


### Documentation

* **yellow-paper:** Add pseudocode for verifying broadcasted functions
in contract deployment
([#4431](AztecProtocol/aztec-packages#4431))
([8bdb921](AztecProtocol/aztec-packages@8bdb921))
</details>

<details><summary>barretenberg: 0.28.0</summary>

##
[0.28.0](AztecProtocol/aztec-packages@barretenberg-v0.27.2...barretenberg-v0.28.0)
(2024-03-14)


### Features

* **avm-simulator:** Euclidean and field div
([#5181](AztecProtocol/aztec-packages#5181))
([037a38f](AztecProtocol/aztec-packages@037a38f))
* Isolate Plonk dependencies
([#5068](AztecProtocol/aztec-packages#5068))
([5cbbd7d](AztecProtocol/aztec-packages@5cbbd7d))
* New brillig field operations and refactor of binary operations
([#5208](AztecProtocol/aztec-packages#5208))
([eb69504](AztecProtocol/aztec-packages@eb69504))
* Parallelize linearly dependent contribution in PG
([#4742](AztecProtocol/aztec-packages#4742))
([d1799ae](AztecProtocol/aztec-packages@d1799ae))
* Update SMT Circuit class and add gate relaxation functionality
([#5176](AztecProtocol/aztec-packages#5176))
([5948996](AztecProtocol/aztec-packages@5948996))


### Bug Fixes

* Barretenberg-acir-tests-bb.js thru version bump
([#5216](AztecProtocol/aztec-packages#5216))
([9298f93](AztecProtocol/aztec-packages@9298f93))
* Intermittent invert 0 in Goblin
([#5189](AztecProtocol/aztec-packages#5189))
([6c70624](AztecProtocol/aztec-packages@6c70624))
* Remove embedded srs
([#5173](AztecProtocol/aztec-packages#5173))
([cfd673d](AztecProtocol/aztec-packages@cfd673d))


### Miscellaneous

* Add dependency instructions to bberg README
([#5187](AztecProtocol/aztec-packages#5187))
([850febc](AztecProtocol/aztec-packages@850febc))
* Moving wit comms and witness and comm labels from instance to oink
([#5199](AztecProtocol/aztec-packages#5199))
([19eb7f9](AztecProtocol/aztec-packages@19eb7f9))
* Oink
([#5210](AztecProtocol/aztec-packages#5210))
([321f149](AztecProtocol/aztec-packages@321f149))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
sklppy88 pushed a commit that referenced this pull request Mar 15, 2024
sklppy88 pushed a commit that referenced this pull request Mar 15, 2024
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-package: 0.28.0</summary>

##
[0.28.0](aztec-package-v0.27.2...aztec-package-v0.28.0)
(2024-03-14)


### ⚠ BREAKING CHANGES

* Support contracts with no constructor
([#5175](#5175))

### Features

* Support contracts with no constructor
([#5175](#5175))
([df7fa32](df7fa32))
</details>

<details><summary>barretenberg.js: 0.28.0</summary>

##
[0.28.0](barretenberg.js-v0.27.2...barretenberg.js-v0.28.0)
(2024-03-14)


### Miscellaneous

* **barretenberg.js:** Synchronize aztec-packages versions
</details>

<details><summary>aztec-cli: 0.28.0</summary>

##
[0.28.0](aztec-cli-v0.27.2...aztec-cli-v0.28.0)
(2024-03-14)


### ⚠ BREAKING CHANGES

* Support contracts with no constructor
([#5175](#5175))

### Features

* Support contracts with no constructor
([#5175](#5175))
([df7fa32](df7fa32))
</details>

<details><summary>aztec-packages: 0.28.0</summary>

##
[0.28.0](aztec-packages-v0.27.2...aztec-packages-v0.28.0)
(2024-03-14)


### ⚠ BREAKING CHANGES

* Support contracts with no constructor
([#5175](#5175))

### Features

* **avm-simulator:** Euclidean and field div
([#5181](#5181))
([037a38f](037a38f))
* Isolate Plonk dependencies
([#5068](#5068))
([5cbbd7d](5cbbd7d))
* New brillig field operations and refactor of binary operations
([#5208](#5208))
([eb69504](eb69504))
* Parallelize linearly dependent contribution in PG
([#4742](#4742))
([d1799ae](d1799ae))
* Parity circuits
([#5082](#5082))
([335c46e](335c46e))
* Support contracts with no constructor
([#5175](#5175))
([df7fa32](df7fa32))
* Track side effects in public
([#5129](#5129))
([d666f6f](d666f6f)),
closes
[#5185](#5185)
* Update SMT Circuit class and add gate relaxation functionality
([#5176](#5176))
([5948996](5948996))


### Bug Fixes

* **avm-transpiler:** FDIV and U128 test case
([#5200](#5200))
([6977e81](6977e81))
* Barretenberg-acir-tests-bb.js thru version bump
([#5216](#5216))
([9298f93](9298f93))
* Do not release docs on every commit to master
([#5214](#5214))
([c34a299](c34a299))
* Fail transaction if we revert in setup or teardown
([#5093](#5093))
([db9a960](db9a960))
* Intermittent invert 0 in Goblin
([#5189](#5189))
([6c70624](6c70624))
* Point docs links to current tag if available
([#5219](#5219))
([0e9c7c7](0e9c7c7))
* Remove embedded srs
([#5173](#5173))
([cfd673d](cfd673d))
* Split setup/teardown functions when there's no public app logic
([#5156](#5156))
([2ee13b3](2ee13b3))
* Validate EthAddress size in aztec-nr
([#5198](#5198))
([201c5e1](201c5e1))


### Miscellaneous

* Add dependency instructions to bberg README
([#5187](#5187))
([850febc](850febc))
* **avm-simulator:** Make sure we support Map storage
([#5207](#5207))
([08835f9](08835f9))
* **avm-simulator:** Restructure contract storage tests
([#5194](#5194))
([fcdd1cc](fcdd1cc))
* **docs:** Add details to getting started contract deployment
([#5220](#5220))
([5c267ae](5c267ae))
* Moving wit comms and witness and comm labels from instance to oink
([#5199](#5199))
([19eb7f9](19eb7f9))
* Oink
([#5210](#5210))
([321f149](321f149))
* Pull noir
([#5193](#5193))
([aa90f6e](aa90f6e))
* Trying to fix intermitent ci failure for boxes
([#5182](#5182))
([f988cb8](f988cb8))


### Documentation

* **yellow-paper:** Add pseudocode for verifying broadcasted functions
in contract deployment
([#4431](#4431))
([8bdb921](8bdb921))
</details>

<details><summary>barretenberg: 0.28.0</summary>

##
[0.28.0](barretenberg-v0.27.2...barretenberg-v0.28.0)
(2024-03-14)


### Features

* **avm-simulator:** Euclidean and field div
([#5181](#5181))
([037a38f](037a38f))
* Isolate Plonk dependencies
([#5068](#5068))
([5cbbd7d](5cbbd7d))
* New brillig field operations and refactor of binary operations
([#5208](#5208))
([eb69504](eb69504))
* Parallelize linearly dependent contribution in PG
([#4742](#4742))
([d1799ae](d1799ae))
* Update SMT Circuit class and add gate relaxation functionality
([#5176](#5176))
([5948996](5948996))


### Bug Fixes

* Barretenberg-acir-tests-bb.js thru version bump
([#5216](#5216))
([9298f93](9298f93))
* Intermittent invert 0 in Goblin
([#5189](#5189))
([6c70624](6c70624))
* Remove embedded srs
([#5173](#5173))
([cfd673d](cfd673d))


### Miscellaneous

* Add dependency instructions to bberg README
([#5187](#5187))
([850febc](850febc))
* Moving wit comms and witness and comm labels from instance to oink
([#5199](#5199))
([19eb7f9](19eb7f9))
* Oink
([#5210](#5210))
([321f149](321f149))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants